Skip to content

chore: JSON chapter_schema#426

Draft
EttyKitty wants to merge 2 commits intoAdeptus-Dominus:mainfrom
EttyKitty:chore/json-things
Draft

chore: JSON chapter_schema#426
EttyKitty wants to merge 2 commits intoAdeptus-Dominus:mainfrom
EttyKitty:chore/json-things

Conversation

@EttyKitty
Copy link
Collaborator

@EttyKitty EttyKitty commented Jan 14, 2025 •
edited by sourcery-ai bot
Loading

Description of changes

  • Descriptions for properties were generated by GPT, after it had a look at the template. A lot of them are just wrong.

How have you tested your changes?

  • Compile
  • New game
  • Next turn
  • Space Travel
  • Ground Battle

Summary by Sourcery

Documentation:

  • Improve the descriptions of chapter properties in chapter_schema.JSON.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 14, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This PR updates the descriptions for properties in the chapter schema JSON files. The incorrect descriptions were generated by GPT and have been manually corrected. A new chapter_schema.JSON file has been added.

File-Level Changes

Change Details Files
Updated descriptions for properties in chapter schema JSON files.
  • Corrected inaccurate descriptions previously generated by GPT.
  • Improved clarity and accuracy of descriptions.
 datafiles/main/chapters/1.JSON
datafiles/main/chapters/2.JSON
datafiles/main/chapters/3.JSON
datafiles/main/chapters/4.JSON
datafiles/main/chapters/5.JSON
datafiles/main/chapters/6.JSON
datafiles/main/chapters/7.JSON
datafiles/main/chapters/8.JSON
datafiles/main/chapters/9.JSON
datafiles/main/chapters/10.JSON
datafiles/main/chapters/11.JSON
datafiles/main/chapters/12.JSON
datafiles/main/chapters/13.JSON
datafiles/main/chapters/14.JSON
datafiles/main/chapters/15.JSON
datafiles/main/chapters/16.JSON
datafiles/main/chapters/17.JSON
datafiles/main/chapters/31.JSON
datafiles/main/chapters/template.JSON
Added chapter_schema.JSON file.
  • Created a new schema file to define the structure of chapter data.
  • Included all necessary properties and their types in the schema.
 datafiles/main/chapters/chapter_schema.JSON
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@EttyKitty EttyKitty mentioned this pull request Jan 14, 2025
Closed
@github-actions github-actions bot added Type: Chore Does something that does't fit other labels Size: Big labels Jan 14, 2025
@EttyKitty EttyKitty added Area: JSON Changes to external JSON files or their under-the-hood functionality and removed Size: Big labels Jan 14, 2025
@github-actions github-actions bot added the Status: Stale No activity for more than a week label Mar 2, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 2, 2025 •
edited
Loading

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot removed the Status: Stale No activity for more than a week label Mar 2, 2025
@EttyKitty EttyKitty added the Status: Stale No activity for more than a week label Mar 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

Area: JSON Changes to external JSON files or their under-the-hood functionality Status: Stale No activity for more than a week Type: Chore Does something that does't fit other labels

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@EttyKitty